GrossWithdrawal

This assignment accepts allocation instructions with methods of percent, amount, units and prorata. Methods for all allocations can be the same or mixed. The total removed from the funds must match the sum of the MoneyTypes and the sum of the cash values removed from the fund's deposits must match the expected fund removal amounts. MoneyType values must be negative.

1. Set the assignment’s “MoneyType value” to the sum total of the MoneyType values.
2. Order the funds in the allocation.
3. For each fund in the allocation,
   1. If the allocation method is percent,
      1. Calculate the fund’s “removal amount” as the assignment’s “MoneyType value” X allocation percent. Round the result to the currency definition.
      2. The last fund is adjusted so that the sum total of fund “removal amounts” is equal to the assignment’s “MoneyType value”.
      3. If the “removal amount” is greater than the fund’s cash value, report an error.
   2. If the allocation method is units,
      1. Calculate fund's "temporary amount" as the allocation units X the fund's unit value for the activity effective date. Round the result to the currency definition.
   3. If the allocation method is amount,
      1. The fund's "removal amount" is the allocation amount.
4. For each fund with the allocation method of units or percent of fund,
   1. Calculate the fund's "removal amount" as the assignment's "MoneyType value" X the fund's "temporary amount" / sum total of "temporary amounts". Round the result to the currency definition.
   2. The last fund is adjusted so that the sum total of fund "removal amounts" is equal to the assignment's "MoneyType value".
   3. If the "removal amount is greater than the fund's cash value, report an error.
5. If no error,
   1. For each fund in reverse order,
      1. If the fund’s “removal amount” is greater than the fund’s value, accumulate the difference and make fund’s “removal amount” equal to the fund’s value. This is the “accumulated difference”.
      2. If the fund’s value is greater than its “removal amount”, add as much of the “accumulated difference” to the fund’s “removal amount” as the fund’s value will allow and adjust the “accumulated difference” by what the fund’s value allowed.
   2. At the end of the loop, error if the “accumulated difference” is greater than 0.
   3. For each non-zero value MoneyType in the order configured,
      1. For each fund in the original order,
         1. If the last non-zero value MoneyType,
            1. Calculate the amount to remove from the fund as the difference of the fund’s “removal amount” and the fund’s “distributed amount”.
         2. Otherwise,
            1. Calculate the fund’s “removal amount” per MoneyType and round to the currency definition: allocation percent X the MoneyType’s value.
            2. The last fund is adjusted so the sum of the “removal amount” values equals the MoneyType’s value.
            3. Accumulate the “removal amount”. This is the “distributed amount".
      2. If tracking by fund, the “removal amount” becomes a FundValuationEffect record.
      3. An ending FundValue record is affected by the “removal amount".
      4. "Remaining removal amount” is set to the fund’s “removal amount”.

      5. If tracking by deposit, For each of the fund’s deposits in LIFO or FIFO order,

         1. Calculate “deposit removal” as the lesser of the deposit’s value and fund’s “remaining removal amount”.
         2. Decrement the “remaining removal amount” by the “deposit removal".
         3. If the “remaining removal amount” is 0, looping through the deposits is complete.

6. If tracking funds by deposit,

   1. For each removal amount from a deposit,

      1. A new DepositValuationEffect record persists the amount of change in a fund’s value and maintains tracking by seed deposit, money type code, bucket (where applicable) and deposit date in the fund.

         1. If the fund is variable and the cash value of the remaining units is less than the smallest denomination of the currency, remove all units.

   2. An ending DepositValue record is created to reflect the ending balances of the deposit’s CashValue, RawCashValue and Units.

      1. An ending record will exist for every beginning DepositValue record.

      2. The difference between beginning and ending record values is the change persisted in the DepositValuationEffect record for the same fund, seed deposit, money type code and deposit date.

   3. An ending FundValue record is created to reflect the ending balances of the fund's CashValue, RawCashValue and Units.

      1. If rounding level is deposit, CashValue is the sum of rounded cash value from the fund's ending DepositValue records.

      2. If rounding level is fund, CashValue is the sum of unrounded cash value from the fund's ending DepositValue records. The result is rounded to currency definition.

      3. Units and RawCashValue are the sum of the units and raw cash values, respectively, from the fund's ending DepositValue records.

7. If not tracking funds by deposit,
   1. A FundValuationEffect record persists the amount of change in a fund’s value.
      1. If the fund is variable and the cash value of the remaining units is less than the smallest denomination of the currency, remove all units.
   2. An ending FundValue record is created to reflect the fund's ending balances.
      1. An ending record will exist for every beginning FundValue record.
      2. The difference between beginning and ending record values is the fund's changes persisted in the FundValuationEffect record.